home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / rabim40.arc / RA-BIM.DOC < prev    next >
Text File  |  1990-04-28  |  12KB  |  303 lines
  1.  
  2.  
  3.   ┌────────────────────────────────────────────────────────────────────────┐
  4.   │                            RA-BiM  v4.00                               │
  5.   │                  BiModem interface for Remote Access                   │
  6.   └────────────────────────────────────────────────────────────────────────┘
  7.                              by Arthur A. Mol
  8.                       The Owl's Nest BBS, Netherlands
  9.                      +31-2155-12571/26527 (2:512/124)
  10.  
  11.  
  12.                               April 28, 1990
  13.                               ──────────────
  14.  
  15.  
  16.    General stuff
  17.    ─────────────
  18.  
  19.    RA-BiM is an interface between Remote Access and BiModem that will use
  20.    all the features of BiModem but also keeps in mind the user limits!
  21.    It started as only an interface for QuickBBS called QuickBIM. Well,
  22.    RA-Bim works much the same as QuickBIM and is easy to install into your
  23.    Remote Access BBS.
  24.  
  25.    RA-BiM will *NOT* work with QuickBBS! (get my point?)
  26.  
  27.    RA-BiM is in no way crippled. Registration only gives you some extra
  28.    features.
  29.  
  30.  
  31.    Features ('*' marked features are changes from version 3.00/3.10)
  32.    ────────
  33.  
  34.    * RA-BiM  now uses FILES.RA to find out what file areas a user has
  35.      access to. RA-BiM looks into  FILES.RA  and  will  compare the
  36.      security levels of each area to the one that the BiModem user has.
  37.      RA-BiM will make a list of all directories to which his security
  38.      level can give him access and will forward this list to BiModem.
  39.      This enforces BiModem only to be capable of sending files from the
  40.      areas that the user has access to.. For instance; users with level
  41.      20 will never receive files from an area that has a level 30 access
  42.      level.
  43.  
  44.      Users with security levels lower than needed for some areas will
  45.      not be able to use BiModem to download from these areas.
  46.      BiModem will give the message 'File not found' in the BiModem
  47.      screen when they try to download from those areas.
  48.  
  49.    * Added support for elimination of escape characters for PCPursuit
  50.      connections. BiModem versions 1.20  and lower use this  escaping
  51.      but it can decrease performance.   With BiModem v1.21 and higher
  52.      versions  you  can  eliminate this escaping.  Add the 'NoEscape'
  53.      keyword  to the RA-BiM  configuration  to enable this feature in
  54.      RA-BiM.  If you run  a version  of BiModem lower than v1.21 then
  55.      this keyword must not be used.
  56.      Note:
  57.      At the time of this writing, the current BiModem version is v1.20
  58.      but because the  Beta  BiModem v1.21  has this feature, I already
  59.      implemented this option into RA-BiM.
  60.  
  61.    * (for registered users only)
  62.      Total Characters Per Second (Cps) is now logged into the RA
  63.      logfile.
  64.  
  65.    * Fixed a small bug which caused RA-BiM not to work proberly when
  66.      executed local.
  67.  
  68.    * Users can select what to do from a short menu that is displayed by
  69.      RA-BiM. (Execute BiModem/Enter files to download/Exit to BBS).
  70.  
  71.    * Users have the option to enter filenames to download before running
  72.      BiModem on the BBS.
  73.  
  74.    * Improved the fossil routines. Communications with the user will
  75.      be smoother (and safer) now.
  76.  
  77.    * Build-in Carrier Detect. If a user drops the carrier, RA-BiM will
  78.      detect this and gives control back to the BBS.
  79.      (This could happen when users are prompted for file descriptions
  80.       or when entering filenames to download)
  81.  
  82.    * ANSI support
  83.  
  84.    - Multi node/multi BiModem support.
  85.  
  86.    - Possibility to use a seperate BiModem.COM for each node
  87.      (eg: BIMOD01.COM, BIMOD02.COM)
  88.  
  89.    - Aborted up/downloads are not recorded. This prevents your users
  90.      yelling at you when a session failed and RA-BiM took credit for the
  91.      whole filelength in the user record.  Also this gets a better
  92.      calculation of downloaded/uploaded Kb's and will prevent corrupted
  93.      uploads because of failed transfers.
  94.  
  95.    - When a user omits to send a description along with an upload, RA-BiM
  96.      will prompt the user for a description after the transfer.
  97.  
  98.    - Username is displayed under the BiModem screen so instantly you can
  99.      see who's using BiModem.
  100.  
  101.    - Time and download limits are displayed locally.
  102.      Note: If a user has exceeded his download limit, the download limit
  103.      will be 1 Kb to prevent BiModem from thinking that the limit is '0'
  104.      which would mean NO limit at all!
  105.  
  106.    - Users can send descriptions of their uploads with BiModem which
  107.      will be added to FILES.BBS in your upload directory.
  108.  
  109.    - If the description for an upload is missing, RA-BiM will ask the
  110.      user for a description of the uploaded file(s).
  111.  
  112.    - Online updating of up/download and time statistics (users see what
  113.      they up/downloaded immediately after the BiModem session ends).
  114.  
  115.    - RA-BiM will execute BiModem with the proper download and time-
  116.      limits, so users can't download or spend more time using BiModem
  117.      than allowed (If a user selects more KB's to download than
  118.      allowed, BiModem will abort the download after his limit has been
  119.      reached. The user can use a verified download the next day to
  120.      resume his filetransfer).
  121.  
  122.    - You have the option to create a logfile with user statistics each
  123.      time a BiModem session is initiated on your BBS.
  124.  
  125.    - If RA-BiM can't find one or more files, a file called RA-BiM?.ERR
  126.      will be created with the name of the file that couldn't be found, so
  127.      when you're not at home, you can always see what went wrong.
  128.      The '?' character in the filename is replaced by the nodenumber that
  129.      called RA-BiM.
  130.  
  131.  
  132.     Extra features for registered users:
  133.     ────────────────────────────────────
  134.  
  135.    - Build-in support for private uploads. A user can start the description
  136.      of his upload with "/".  RA-BiM will then add that file as a private
  137.      upload and will store the description  to  PFILES.BBS in the upload
  138.      directory.
  139.  
  140.    - An RA compatible log entry will be added to the RA logfile for each
  141.      filetransfer done by BiModem. This entry looks like the normal
  142.      transfer entries that RA writes for transfers like Zmodem and
  143.      other protocols.
  144.      Both logfile formats (Opus or Frontdoor style) are supported.
  145.  
  146.    - You know that you are supporting shareware!  This must make you feel
  147.      very good!
  148.  
  149.  
  150.  
  151.    Installing RA-BiM:
  152.    ──────────────────
  153.  
  154.    RA-BiM must be installed into Remote Access as a menu type 7.
  155.    Create a menu type 7 in your files menu that will contain the
  156.    following info on the optional data line:
  157.  
  158.    RA-BiM RA-BiM.CTL path&filename, nodenumber, /L (optional)
  159.  
  160.    Example:
  161.  
  162.     RA-BiM C:\RA\RA-BiM.CTL *N /L
  163.  
  164.    (Note: RA-BiM is not hardcoded for a config file named RA-BiM.CTL.
  165.           Use any configuration filename that you like. This also
  166.           enables you to use seperate .CTL files for certain menu-
  167.           (BiModem) options!)
  168.  
  169.    Make sure to enter the drivename along with the pathnames.  Strange
  170.    things can occure if you don't!
  171.  
  172.    The parameter "/L" is optional. If found, a logfile called RA-BiM?.LOG
  173.    will be created with user  statistics  before  and  after  the  BiModem
  174.    session. The '?' character is replaced by the nodenumber that calls
  175.    RA-BiM.
  176.  
  177.    It's also recommended to enable the memory swap feature by adding *M
  178.    to the commandline.
  179.  
  180.    The RA-BiM control file must contain the following information:
  181.  
  182.    - Full path and filename of the BiModem configuration file
  183.    - Logfile format (Opus/Frontdoor style) to be used
  184.    - For each node a line must be supplied with the full pathname of that
  185.      node's directory and the path to the BiModem.COM file to use for each
  186.      node.
  187.  
  188.    Take your favorite text editor and create a file which will be used
  189.    as the configuration file for RA-BiM.
  190.    Then use the following keywords to enter the information in this
  191.    file:
  192.  
  193.    BiModemCfg   Full drive and pathname of the BiModem configuration file
  194.  
  195.    LogFormat    The format of your RA system's logfile.
  196.                 Valid options are:
  197.  
  198.                 LogFormat Opus      (Opus logfile format)
  199.                 LogFormat Frontdoor (Frontdoor logfile format)
  200.  
  201.    Node         Keyword used to supply pathname information for each
  202.                 node.
  203.  
  204.    NoEscape     This keyword is optional. Use this only if you run
  205.                 a BiModem version higher than v1.20. It will have no
  206.                 effect on BiModem v1.20 or lower versions.
  207.  
  208.    The RA-BiM configuration file could look something like this:
  209.  
  210.    BiModemCfg C:\PROTOCOLS\BIMODEM.CFG
  211.    NoEscape
  212.    LogFormat Opus
  213.    Node 1 D:\RA1 D:\RA1\RA1.LOG D:\PROTOCOLS\BIMOD01.COM
  214.    Node 2 D:\RA2 D:\RA2\RA2.LOG D:\PROTOCOLS\BIMOD02.COM
  215.    Node 3 E:\RA3 D:\RA3\RA3.LOG D:\PROTOCOLS\BIMOD03.COM
  216.         │ │      │              │
  217.         │ │      │              └────> Full path and filename of the
  218.         │ │      │                     BiModem.COM file used for each node.
  219.         │ │      │
  220.         │ │      └─────> Full path and filename for the logfile of this node.
  221.         │ └────────────> Full pathname for this node.
  222.         └──────────────> Node number
  223.  
  224.  
  225.    An example configuration file for RA-BiM is included in the distribution
  226.    archive.
  227.  
  228.  
  229.    Notes:
  230.    ──────
  231.  
  232.    You *MUST* supply the full pathnames for all keywords in the RA-BiM
  233.    configuration file. So always use 'D:\TEST\TEST.COM' (or whatever)
  234.    instead of only '\TEST\TEST.COM' or worse: only 'TEST.COM'.
  235.    This also must be done when entering pathnames in BiConfig. RA-BiM
  236.    looks for the drivenames in order to find/store certain files so
  237.    pathnames *MUST* be proceeded by the drivename!
  238.  
  239.    Also set all logging to "YES". This will enable RA-BiM to use a part of
  240.    the logfile (for reading only).
  241.    If the BiModem logfile cannot be found because you don't have one (yet)
  242.    RA-BiM will exit with 'cannot open BiModem logfile' (or something alike).
  243.    If this happens, you can create a BiModem logfile by hand. This can be
  244.    a short file with only one CR in it.
  245.  
  246.    RA-BiM was succesfully tested on several machines from 8Mhz XT's with
  247.    640Kb up to 25Mhz 386's with USR Dual Standard modems using Desqview
  248.    2.26/QEMM 5.00. Also Remote Access v0.03/b-7 and BiModem v1.21ß behaved
  249.    nice with RA-BiM..
  250.  
  251.  
  252.  
  253.  
  254.    Credits:
  255.    ────────
  256.  
  257.    The guys of Continental Software for sharing RA with us.
  258.    quote: "Later dude.."
  259.  
  260.    Dave Krause    - BiModem freak / SysOp Valley of the Sun (1:114/42)
  261.    quote: "Excellent, we'll take a look at it!"
  262.  
  263.    Peter Janssens - SysOp of EasyBoard NL (2:512/1)
  264.    quote: "QEMM reported somekind of error and the system is locked now...
  265.            why me?"
  266.  
  267.    Rob van Hoeven - Co-SysOp of RA Support Europe (2:512/100) and author
  268.                     of many great RA/QBBS programs.
  269.    quote: "NAK, NAK, NAK ..."
  270.  
  271.    Reinier de Groot - SysOp of RA Support Europe (2:512/100)
  272.    Quote: "Why not?"
  273.  
  274.  
  275.   ┌────────────┐
  276.   │ DISCLAIMER │
  277.   └────────────┘
  278.  
  279.    Every program seems to have a disclaimer, so I decided to include one
  280.    too!
  281.    This program is provided "as is" without warranty of any kind. The user
  282.    of this program agrees to hold the author of this material harmless for
  283.    any direct or consequential damages from its use.
  284.  
  285.    The latest release of RA-BiM is always requestable at my node (2:512/124)
  286.    under the 'magic' filename RA-BiM or RABIM.
  287.  
  288.    If you would like to register RA-BiM, then send $15 (foreign orders)
  289.    or Hfl 25,- to the address below. Please include your name, BBS name
  290.    and (optional) net/nodenumber of your system.
  291.  
  292.  
  293.     Arthur A. Mol
  294.     P.O. Box 227
  295.     3760 AE  Soest
  296.     Netherlands
  297.  
  298.     BBS The Owl's Nest
  299.     +31-2155-12571 (1200/2400/9600/14400bps HST/V32)
  300.     +31-2155-26527 (300/1200/2400bps)
  301.  
  302.     Fidonet address: 2:512/124
  303.